Get a Tenant's Users with specific license type
{ getTenantUsersByUserType }
Returns a list of all users for a given tenant and license type.
Method
- Enterprise Admin
Input Parameters
Name
tenantUsersGetObject
Object Type
Description
The tenant object for fetching users.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
Returns a generic response object with the list of users for the tenant in the system. Note that the response is returned as a list of items of this object type.
Notes
The user object can be used in other operations where it is required.
Examples
![Closed](../../../../../../../../Skins/Default/Stylesheets/Images/transparent.gif)
This example demonstrates how to find item's and the manipulation of content tags.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";
// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
"userName":"adminUser",
"password":"abc123!"
},"",false);
//step 2: search for tenant by name
let tenant=callApi("access/getTenantByName","Company X",token);
let tenantId;
//step 3: if tenant is found, get its ID. Otherwise create the tenant
if(tenant.data != undefined){
tenantId=tenant.data.id;
log("found tenant with id "+ tenantId);
}else{
log("tenant was not found ,creating one");
let createTenantResult = callApi("access/createTenant",{
"name": "Company X",
"viewerSeats": 1,
"proSeats": 1
},token);
tenantId = createTenantResult.data.modifiedList[0].id;
}
//step 4: delete the tenant we found in step 2
let deleteTenants=callApi("access/deleteTenants",{
"tenantIds": [
tenantId
],
"deleteUsers": true,
"deleteServers": true
},token);
//step 5: get the default tenant
let defaultTenant = callApi("access/getDefaultTenant",{
"auth": token
});
let defaultTenantId = defaultTenant.data;
//step 6: get available licenses by type for default tenant
let proSeatsNumber = callApi("access/getTenantUnusedLicenseCount",{
"tenantId": defaultTenantId,
"licenseType": 200,
},token);
log("The default tenant has "+ proSeatsNumber.data + " available pro seats licenses");
//step 7: get available users for tenant by license type
let proSeatsUsersData = callApi("access/getTenantUsersByUserType",{
"tenantId": defaultTenantId,
"clientLicenseType": 200,
},token);
// ##### optional generic logging method for debugging ##############
function log(msg){
document.write(msg);
console.log(msg);
}
// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
var xhttp = new XMLHttpRequest();
xhttp.open("POST", pyramidURL+path, false);
xhttp.setRequestHeader("paToken",token)
xhttp.send(JSON.stringify(data));
if(parseResult){
return JSON.parse(xhttp.responseText);
}else{
return xhttp.responseText;
}
}
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/access/getTenantUsersByUserType" \
-d '{
"tenantId" : "tenantId"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AccessServiceApi;
import java.util.*;
import java.time.*;
public class AccessServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
AccessServiceApi apiInstance = new AccessServiceApi();
// Initialize the tenantUsersGetObject parameter object for the call
TenantUsersGetObject tenantUsersGetObject = ; // Create the input object for the operation, type: TenantUsersGetObject
try {
// "array[PyramidViewUserObject]" is only psaudo-code to symbolize list of type and not the actual usage
array[PyramidViewUserObject] result = apiInstance.getTenantUsersByUserType(tenantUsersGetObject);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#getTenantUsersByUserType");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const tenantUsersGetObject = ; // {TenantUsersGetObject}
api.getTenantUsersByUserType(tenantUsersGetObject).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class getTenantUsersByUserTypeExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AccessServiceApi();
// Initialize the tenantUsersGetObject parameter object for the call
var tenantUsersGetObject = new TenantUsersGetObject(); // TenantUsersGetObject |
try {
// Returns a list of all users for a given tenant and license type.
// "array[PyramidViewUserObject]" is only psaudo-code to symbolize array of type and not the actual usage
array[PyramidViewUserObject] result = apiInstance.getTenantUsersByUserType(tenantUsersGetObject);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.getTenantUsersByUserType: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AccessServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = AccessServiceApi(api_client)
# Initialize the tenantUsersGetObject parameter object for the call
tenantUsersGetObject = # TenantUsersGetObject |
try:
# Returns a list of all users for a given tenant and license type.
api_response = api_instance.get_tenant_users_by_user_type(tenantUsersGetObject)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->getTenantUsersByUserType: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
$tenantUsersGetObject = ; // TenantUsersGetObject |
try {
$result = $api_instance->getTenantUsersByUserType($tenantUsersGetObject);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->getTenantUsersByUserType: ', $e->getMessage(), PHP_EOL;
}
?>